<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="connectors_v2.html">Connectors API</a> . <a href="connectors_v2.projects.html">projects</a> . <a href="connectors_v2.projects.locations.html">locations</a> . <a href="connectors_v2.projects.locations.connections.html">connections</a> . <a href="connectors_v2.projects.locations.connections.entityTypes.html">entityTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="connectors_v2.projects.locations.connections.entityTypes.entities.html">entities()</a></code>
</p>
<p class="firstline">Returns the entities Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, contextMetadata=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets metadata of given entity type</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists metadata related to all entity types present in the external system.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, contextMetadata=None, view=None, x__xgafv=None)</code>
  <pre>Gets metadata of given entity type

Args:
  name: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} (required)
  contextMetadata: string, Context metadata for request could be used to fetch customization of entity type schema.
  view: string, Specifies view for entity type schema.
    Allowed values
      ENTITY_TYPE_SCHEMA_VIEW_UNSPECIFIED - VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.
      ENTITY_TYPE_SCHEMA_VIEW_BASIC - Return basic entity type schema.
      ENTITY_TYPE_SCHEMA_VIEW_ENRICHED - Return enriched entity types schema.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EntityType message contains metadata information about a single entity type present in the external system.
  &quot;defaultSortBy&quot;: &quot;A String&quot;,
  &quot;fields&quot;: [ # List containing metadata information about each field of the entity type.
    { # Message contains EntityType&#x27;s Field metadata.
      &quot;additionalDetails&quot;: { # The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
      },
      &quot;dataType&quot;: &quot;A String&quot;, # The data type of the Field.
      &quot;defaultValue&quot;: &quot;&quot;, # The following field specifies the default value of the Field provided by the external system if a value is not provided.
      &quot;description&quot;: &quot;A String&quot;, # A brief description of the Field.
      &quot;jsonSchema&quot;: { # JsonSchema representation of schema metadata # JsonSchema of the field, applicable only if field is of type `STRUCT`
        &quot;additionalDetails&quot;: { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;default&quot;: &quot;&quot;, # The default value of the field or object described by this schema.
        &quot;description&quot;: &quot;A String&quot;, # A description of this schema.
        &quot;enum&quot;: [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          &quot;&quot;,
        ],
        &quot;format&quot;: &quot;A String&quot;, # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        &quot;items&quot;: # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
        &quot;jdbcType&quot;: &quot;A String&quot;, # JDBC datatype of the field.
        &quot;properties&quot;: { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
          &quot;a_key&quot;: # Object with schema name: JsonSchema
        },
        &quot;required&quot;: [ # Whether this property is required.
          &quot;A String&quot;,
        ],
        &quot;type&quot;: [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          &quot;A String&quot;,
        ],
      },
      &quot;key&quot;: True or False, # The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
      &quot;name&quot;: &quot;A String&quot;, # Name of the Field.
      &quot;nullable&quot;: True or False, # Specifies whether a null value is allowed.
      &quot;reference&quot;: { # Reference captures the association between two different entity types. Value links to the reference of another entity type.
        &quot;name&quot;: &quot;A String&quot;, # Name of the reference field.
        &quot;type&quot;: &quot;A String&quot;, # Name of reference entity type.
      },
    },
  ],
  &quot;jsonSchema&quot;: { # JsonSchema representation of schema metadata # JsonSchema representation of this entity&#x27;s schema
    &quot;additionalDetails&quot;: { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
    },
    &quot;default&quot;: &quot;&quot;, # The default value of the field or object described by this schema.
    &quot;description&quot;: &quot;A String&quot;, # A description of this schema.
    &quot;enum&quot;: [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
      &quot;&quot;,
    ],
    &quot;format&quot;: &quot;A String&quot;, # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
    &quot;items&quot;: # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
    &quot;jdbcType&quot;: &quot;A String&quot;, # JDBC datatype of the field.
    &quot;properties&quot;: { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
      &quot;a_key&quot;: # Object with schema name: JsonSchema
    },
    &quot;required&quot;: [ # Whether this property is required.
      &quot;A String&quot;,
    ],
    &quot;type&quot;: [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
      &quot;A String&quot;,
    ],
  },
  &quot;metadata&quot;: { # Metadata like service latency, etc.
    &quot;a_key&quot;: {
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # The name of the entity type.
  &quot;operations&quot;: [
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
  <pre>Lists metadata related to all entity types present in the external system.

Args:
  parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection} (required)
  pageSize: integer, Number of entity types to return. Defaults to 25.
  pageToken: string, Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types.
  view: string, Specifies which fields of the Entity Type are returned in the response.
    Allowed values
      ENTITY_TYPE_VIEW_UNSPECIFIED - VIEW_UNSPECIFIED. The unset value. Defaults to FULL View.
      ENTITY_TYPE_VIEW_BASIC - Return only entity type names.
      ENTITY_TYPE_VIEW_FULL - Return entity types with schema
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for EntityService.ListEntityTypes
  &quot;metadata&quot;: { # Metadata like service latency, etc.
    &quot;a_key&quot;: {
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  },
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token if more entity types available.
  &quot;types&quot;: [ # List of metadata related to all entity types.
    { # EntityType message contains metadata information about a single entity type present in the external system.
      &quot;defaultSortBy&quot;: &quot;A String&quot;,
      &quot;fields&quot;: [ # List containing metadata information about each field of the entity type.
        { # Message contains EntityType&#x27;s Field metadata.
          &quot;additionalDetails&quot;: { # The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
          &quot;dataType&quot;: &quot;A String&quot;, # The data type of the Field.
          &quot;defaultValue&quot;: &quot;&quot;, # The following field specifies the default value of the Field provided by the external system if a value is not provided.
          &quot;description&quot;: &quot;A String&quot;, # A brief description of the Field.
          &quot;jsonSchema&quot;: { # JsonSchema representation of schema metadata # JsonSchema of the field, applicable only if field is of type `STRUCT`
            &quot;additionalDetails&quot;: { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;default&quot;: &quot;&quot;, # The default value of the field or object described by this schema.
            &quot;description&quot;: &quot;A String&quot;, # A description of this schema.
            &quot;enum&quot;: [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
              &quot;&quot;,
            ],
            &quot;format&quot;: &quot;A String&quot;, # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
            &quot;items&quot;: # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
            &quot;jdbcType&quot;: &quot;A String&quot;, # JDBC datatype of the field.
            &quot;properties&quot;: { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
              &quot;a_key&quot;: # Object with schema name: JsonSchema
            },
            &quot;required&quot;: [ # Whether this property is required.
              &quot;A String&quot;,
            ],
            &quot;type&quot;: [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
              &quot;A String&quot;,
            ],
          },
          &quot;key&quot;: True or False, # The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
          &quot;name&quot;: &quot;A String&quot;, # Name of the Field.
          &quot;nullable&quot;: True or False, # Specifies whether a null value is allowed.
          &quot;reference&quot;: { # Reference captures the association between two different entity types. Value links to the reference of another entity type.
            &quot;name&quot;: &quot;A String&quot;, # Name of the reference field.
            &quot;type&quot;: &quot;A String&quot;, # Name of reference entity type.
          },
        },
      ],
      &quot;jsonSchema&quot;: { # JsonSchema representation of schema metadata # JsonSchema representation of this entity&#x27;s schema
        &quot;additionalDetails&quot;: { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;default&quot;: &quot;&quot;, # The default value of the field or object described by this schema.
        &quot;description&quot;: &quot;A String&quot;, # A description of this schema.
        &quot;enum&quot;: [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          &quot;&quot;,
        ],
        &quot;format&quot;: &quot;A String&quot;, # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        &quot;items&quot;: # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
        &quot;jdbcType&quot;: &quot;A String&quot;, # JDBC datatype of the field.
        &quot;properties&quot;: { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
          &quot;a_key&quot;: # Object with schema name: JsonSchema
        },
        &quot;required&quot;: [ # Whether this property is required.
          &quot;A String&quot;,
        ],
        &quot;type&quot;: [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          &quot;A String&quot;,
        ],
      },
      &quot;metadata&quot;: { # Metadata like service latency, etc.
        &quot;a_key&quot;: {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # The name of the entity type.
      &quot;operations&quot;: [
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;unsupportedTypeNames&quot;: [ # List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>